// --------------------------------------------------------------------------------------------------------------------
// <copyright file="JResultCode.cs" company="Jarno Burger / Dennis de Bruijn">
//   Jarno Burger / Dennis de Bruijn
// </copyright>
// <summary>
//   resultcodes for functions
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace ManagedFreeFrame.Enum
{
    /// <summary>
    ///   result codes for functions
    /// </summary>
    /// <remarks>
    ///   - In functions that return error codes any value other than 0 is assumed to be an error code. 
    ///   - In functions that return a pointer, (hex) FFFFFFFF also represents a failure condition.
    /// </remarks>
    public enum ResultCode
    {
        /// <summary>
        /// all went ok
        /// </summary>
        FfSuccess = 0,

        /// <summary>
        /// failed in doing the function
        /// (hex) FFFFFFFF
        /// </summary>
        FfFail = 1,

        /// <summary>
        /// used as bool
        /// </summary>
        FfTrue = 1,

        /// <summary>
        /// used as bool
        /// </summary>
        FfFalse = 0,
        
        /// <summary>
        /// this is supported
        /// </summary>
        FfSupported = 1,

        /// <summary>
        /// this isnt supported
        /// </summary>
        FfUnsupported = 0
    }
}